home *** CD-ROM | disk | FTP | other *** search
/ System Booster / System Booster.iso / Commodities / DiskExec / DiskExec.DOC < prev    next >
Text File  |  1996-09-26  |  11KB  |  219 lines
  1.                               DiskExec V1.20
  2.                               --------------
  3.  
  4. Written By: Yanik Grignon            Technical Writer: Scott Pinard
  5. ----------  10848 Jean-Masse         ----------------  5522 Eadie
  6.             Montreal, Quebec                           Montreal, Quebec
  7.             Canada.  H4J 1S1                           Canada. H4E 3S6
  8.             grignony@jsp.umontreal.ca                  rslayer@info.polymtl.ca
  9.             FidoNet: 1:167/207.0                         FidoNet: 1:167/207.0
  10.             AmigaNet: 40:600/207                       AmigaNet: 40:600/207
  11.  
  12.             IRC Nick: RSlayer                          IRC Nick: TritN
  13.  
  14.  
  15. LICENSE:
  16. -------
  17.     This Program is PostCard-Ware and we ask that anyone who finds this 
  18. program usefull, and uses it on a regular basis to please send the Requested
  19. Nominal fee of 1 Postcard of your City. (of course 68040 Accelerator would
  20. be nice) :) Considering the Hard work that went into this Program to keep its
  21. sized down to a minimum, and insure it be Bug free before its release, we are
  22. not asking very much. Also to encourage the Programer to Continue Working on
  23. Great programs for all to enjoy. We are thinking of working on a Much more
  24. Configurable Version that will not be Limited to just Disk Inserts and
  25. Removes. We hope to support Window Opens/Closes, Double Clicks,etc..)
  26. Please send your PostCards to Yanik Grignon or Scott Pinard at the Adresses
  27.  Above.
  28.  
  29. Note: Please Indicate any comment or Bugs (Yeah Right!) on the Postcard as
  30. well as the Setup your using DiskExec on. Thank you for your Support.
  31.  
  32.  
  33. DISTRIBUTION OF DISKEXEC:
  34. ------------------------
  35.     You can freely distribute DiskExec as long as the Following is
  36.     Observed:
  37.  
  38.     -   The program and documentation must be distributed together and 
  39.     not modified in any way.  The only exception is that the program and
  40.     documentation may be compressed into an archive for uploading to
  41.     Bulletin Boards or for other electronic transmission.
  42.  
  43.     -   The program is not to be included in a commercial package for profit
  44.     unless written authorisation from Yanik Grignon is obtained first. This
  45.     version of DiskExec may be freely included on public domain library disks
  46.     or compilation disks provided only a small fee is charged for the service.
  47.  
  48.  
  49. CONTENTS OF ARCHIVE:
  50. -------------------
  51. - DiskExec          - The Commodity Program.
  52. - DiskExec_Reg.info - The Icon for DiskExec for Regular WBs \_ Contain the
  53. - DiskExec_MWB.info - The Icon for DiskExec For MagicWB WBs /  Datatypes.
  54. - DiskExec.doc      - The File your Currently reading :)
  55. - DiskExec.doc.info - The Icon For the Docs.
  56. - Changes.txt       - List of Changes in Version 1.20
  57. - Changes.txt.info  - Icon For Changes.txt
  58. - pho.displayme     - Advertisement for our BBS in Montreal,Que. Canada
  59.  
  60. ABOUT DISKEXEC:
  61. --------------
  62.     DiskExec is a program (Actually a Commodity) that is a little bit hard
  63.  to describe.  It all started when I asked my friend Yanik Grignon to make
  64.  me a program to replace this old sharware Program I had lost called 
  65.  "DiskTalk" which would play Sound Samples when a Disk was Inserted and
  66.  Removed. After a Long Discussion we decided we could make the Program Much
  67.  better than that. We decided it would not be limited to sound samples.
  68.  Actually what the program does is Executes literaly anything when a disk is
  69.  inserted or removed. Actualy any two things as the Program treats each task
  70.  (Insert,Remove) seperatly,hence one executed task for insert, another for
  71.  remove. I will discuss applications of the program later on in the manual.
  72.  
  73.  
  74. DISKEXEC'S SYSTEM REQUIREMENTS:
  75. ------------------------------
  76.     As DiskExec is a Commodity, it requires OS2.04 or later. If you require
  77. a version of DiskExec for Workbench 1.3 or earlier, Send us Mail
  78. (Electronic or snail) at the Address at the begining of this Doc. Of course
  79. the OS1.3 version is a Command Line (CLI) version only. 
  80.  
  81.    Although a HardDrive is not a Neccessity (due to DiskExec's size) it
  82. will make the Program a lot more usefull and Quicker.
  83.  
  84.     DiskExec has been tested on several Systems ECS, and AGA to ensure
  85. compatibitly. I Personaly have tested it on an A500,A2000HD (Accelerated
  86. and Not), and an A1200HD. It works like a charm on all of em.
  87.  
  88.  
  89. APPLICATIONS FOR DISKEXEC:
  90. -------------------------
  91.     This is a Really hard section to write as the Posibilities are truely
  92. Endless. But I Will List a few of the More Common Ones People would want to
  93. use this Program for..
  94.  
  95.     As I said earlier, DiskExec Will Literaly run anything when it detects
  96. a Disk Insert/remove because Yanik programed it to Actually execute a
  97. Command line. So Anything that can Be Executed, be it Program, Script,
  98. etc.. will work with DiskExec. Simply place your Command line in the
  99. Tooltypes to have DiskExec execute them. Now for some Examples:
  100.  
  101. 1) Sound Samples: This is What I use DiskExec for. All you need to make
  102. DiskExec to Play sound Samples is a Sample Player (SMPlay included in the
  103. SoundMachine Package or Play8SVX included in ReqTools Package are good
  104. ones) and Sound Samples. Here is my Tooltypes List for Playing Sound
  105. Samples:
  106.                  INSERTED=Play8SVX dh0:s/DE_IN.iff
  107.                  REMOVED=Play8SVX dh0:s/DE_Out.iff
  108.         
  109.                           ^^Player    ^^Path and Sample
  110.  
  111. In Other Words you place the actual command line as if you were going to
  112. run it in a Shell Manualy, so DE knows and can do this Automaticly.
  113.  
  114. 2) Load a Picture: Someone pointed out to us that it would be funny to have
  115. your System display Some kind of Picture With a "Thank you for Inserting a
  116. Disk" or "a Disk has been Inserted" text in it. If you wish to do this too,
  117. all you'll need is a Picture Viewer and Pictures. A neat way of Customizing
  118. your WorkBench.
  119.  
  120. 3) Loging Disk Activity: This is very usefull for Networked Amigas as well
  121. as Normal Users. For a Network of Amigas Disk Exec can keep track of Every
  122. Disk Put into the Network by Using DiskExec to Log all Disks (and there
  123. Names, or Content if you wish) being inserted into the Computers of your
  124. Network. This is Very good for Ensuring no one is Bringing and Playing
  125. games and/or Copying (c)opyright Software on your Network. The reasons for
  126. loging disks are Numerous. For the Regular user, you can use this Loging of
  127. Disks by DiskExec to Track Down that Elusive Virus that keeps Plaguing your
  128. Amiga.. When you load your Computer, And have DiskExec configured for
  129. Loging Disks, Every disk you insert will be loged and when a Virus is
  130. Detected on your System you need only look in your log file for the disks
  131. you inserted. One of these Disks is the Infected one..
  132.  
  133. 4) Executing a Script: This I leave up to the User to Imagine. It can be
  134. used to aid the Log Disk Process (ie. you can have a Script that logs the
  135. Disk Name, Content, time of day, and date) thus when a Disk is inserted the
  136. Script will be run, thus loging all the info you require of that Disk.
  137. Other Uses are left to the Imagination of the User.
  138.  
  139.  If you Find any other Usefull uses of DiskExec Please let Us know so
  140. we can include it in the Next Version. Share the Wealth as they Say.
  141.   
  142.  
  143. HOW TO USE DISKEXEC:
  144. -------------------
  145.  DiskExec is Extremly easy to use as it is a Commodity. First Choose the icon
  146. you want to Use (Regular or MagicWB) and ReName it Simply: DiskExec.info
  147. and delete the other one then Drag the Icon into your WBStartup Drawer, Set
  148. the ToolTypes, and Run it (or Reboot). To Kill it, simply Run it a second
  149. time or use Exchange.
  150.  
  151.  
  152. SETTING THE TOOLTYPES:
  153. ---------------------
  154.  To configure the Tooltypes Simply Click Once on DiskExec's Icon and
  155.  Select Information in the ICONS menu of WorkBench. Please Remove the (,)'s
  156. that surround the tooltype to be able to use them.
  157.  
  158. CX_PRIORITY=0      : This Tooltype allows you to set the Priority of the
  159.                      Commodity which if set to a higher value will give
  160.                      DiskExec Priority over other Commodities. 
  161.  
  162. INSERTED=<command> : This is where you put your Command line for a Disk
  163.                      Being Inserted. Simply delete the "<command>" and
  164.                      place your own command line right after the = (no
  165.                      space after the "=")
  166.  
  167. REMOVED=<command>  : This is where you put your Command line for a disk
  168.                      being Removed. Simply delete the "<command>" and
  169.                      place your own command line right after the = (No
  170.                      space after the "=")
  171.  
  172. ONCE=<TRUE|FALSE>  : This is the New Feature. Due to the OS treating each
  173.                      DOSDrivers as a seperate insert it makes DiskExec 
  174.                      execute run your setting once for each Disk insert/
  175.                      remove (Annoying) Anyone with PCx: or DSx: Drivers
  176.                      set this to TRUE (Default). If you want DiskExec to 
  177.                      continue to execute each command 2-3 times put it at
  178.                      False. Simply delete the "<TRUE|FALSE>" and put either
  179.                      TRUE or FALSE in its place right after the = (No
  180.                      space after the "=")
  181. HISTORY:
  182. -------
  183.  
  184. DiskExec has been changed Dramaticly since its First Beta Release. For One
  185. thing. It was Originaly Programed in E. This was for two Reasons. 1) He was
  186. programming in E when I asked him about my Idea and 2) as a Test to see if
  187. he could do it in E. The Original CLI Version (in E) worked very well but
  188. We wanted to make it a Commodity. After weeks of trying to get the program
  189. to to read information out of the tooltypes, Yanik gave up on E and rewrote
  190. DiskExec in C. After Switching to C, the Commodity version emerged rather
  191. quickly.
  192.         ***Programers Note: If anyone knows how to get an E Program to read
  193.            its Info from the Icon ToolTypes, I am Still interested in finding
  194.            out to further my knowledge of E and for Future Projects..***
  195.  
  196. Version #'s:                       Comment:
  197. -----------               -------
  198.   0.10               Original CLI Version (written in E - Never Released)
  199.   Several #'s        Several Attempts at Commodity Version in E (Never Worked)
  200.   0.90               First Beta Release of Commodity (Re-Written in C)
  201.   1.00               First Official Release of DiskExec (Commodity Version)
  202.   1.10               Yes We actually Found a Bug.. If you tried to Run Disk
  203.                      Exec without any Parameters, Nothing Happened. It Was
  204.                      Supposed to use the Sound Prefs of WB to either Make
  205.                      a Beep or ScreenFlash,etc.. Also we Made the Program
  206.                      even Smaller, Now 4k.. Yeah!! See Changes.txt for full
  207.                      list of Changes.. 
  208.    1.20              We removed the Sound Prefs feature added in 1.10 as it
  209.                      didn't seem to work on any other computer besides the
  210.                      programmers (and even then it stoped working after a 
  211.                      few days, Weird) Added the ONCE=<TRUE|FALSE> tooltype
  212.                      to solve a Problem that occurs due to the Way the
  213.                      Amiga handles DOS Drivers like PCx: and DSx: (see
  214.                      setting the Tooltypes for info)
  215.  
  216.      ------------------------------------------------------------------
  217.      \/\/\/\/\/\/\/\/\/\/\/\/\/\/ THE END /\/\/\/\/\/\/\/\/\/\/\/\/\/\/  
  218.      ------------------------------------------------------------------
  219.